SureTax Returns API

GET Upload Request Status

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

This API endpoint allows users to retrieve the status of a specific upload process and obtain detailed error messages for any tax items that may have inconsistencies. By querying this endpoint, users can monitor the progress of their upload requests, identify any tax items that failed to upload correctly, and access error messages to troubleshoot and resolve issues effectively. This functionality facilitates seamless data management and ensures the integrity of tax item uploads within the system.

OperationId: GET Upload Request Status

Authorization Method(s): OAuth

Verb: GET

End Point: /api/v1/Forms/UploadRequestStatus

Query Parameters

Query parameters in an API operation are key-value pairs that are included in the URL of an API request to filter or modify the data returned by the API. They come after the `?` in the URL and are often used to pass optional parameters like search terms, pagination information, sorting criteria, or filters to narrow down the data in the response.

Display String	Field Name	Field Type
Id*	id	string

*Mandatory parameter

UploadRequestStatusResponse

OVERVIEWEXAMPLE

Overview

UploadRequestStatusResponse

Display Name	Field Name	Field Type
Data	data	array[UploadStatus]

UploadStatus

Display Name	Field Name	Field Type
Upload Status	uploadStatus	string
Message	message	string
Total Number Of Lines	totalNumberOfLines	string
Items With Messages	itemsWithMessages	array[ItemsMessages]

ItemsMessages

Display Name	Field Name	Field Type
Company Code	companyCode	string
Document Number	documentNumber	string
Fiscal Year	fiscalYear	string
Item Number	itemNumber	string
Message	message	string
Item Status	itemStatus	string

Example Response

The following is an example response you can expect for this operation

{
  "data": [
    {
      "uploadStatus": "2",
      "message": "null",
      "totalNumberOfLines": "1",
      "itemsWithMessages": [
        {
          "companyCode": "XAX",
          "documentNumber": "8111100778",
          "fiscalYear": "2024",
          "itemNumber": "1",
          "message": "Duplicate invalid record 2 times",
          "itemStatus": "E"
        }
      ]
    }
  ]
}

Response Codes

Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.

code	description
200	The API responds to the current upload status and errors if they exist. Success Response - 200 OK. The API will respond the status with a list of messages and their information.
204	204 No Content If no records are found for the provided request, the API will respond with a No Content status.
400	Bad Request - The server could not process the request due to invalid input or missing required parameters.
401	401 Unauthorized: The user's authentication is not valid.
500	Internal Server Error - An unexpected error occurred on the server while processing the request.

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:

/api/v1/Forms/UploadRequestStatus

Add Request Headers: